home *** CD-ROM | disk | FTP | other *** search
/ TPUG - Toronto PET Users Group / TPUG Users Group CD / TPUG Users Group CD.iso / AMIGA / (A)TB / (A)TBB.ADF / CLI_Help / Help.DOC < prev    next >
Text File  |  1989-04-08  |  5KB  |  112 lines
  1.  
  2.                         HELP!  CLI Help Program
  3.                         Version 1.0  October 88
  4.                       (c) Copyright 1988 G.Ismay
  5.  
  6.  
  7.                               INTRODUCTION
  8.  
  9. HELP! is a program that provides a simple help facility for CLI users.
  10. HELP! can find a single keyword in up to twenty six different help files
  11. and display information relative to that keyword.  This allows  you  to
  12. have up to 832 Kbytes of help on-line at any one time, which should be
  13. enough for most people! A complete help file is included on this disk
  14. containing help on all the AmigaDos commands.
  15.  
  16.                             INSTALLING HELP!
  17.  
  18. For HELP! to work properly, at least two files are required; the HELP!
  19. program itself and a help file called HelpA.HELP. These files are
  20. included on this disk and should be copied to any of your CLI disks
  21. that you would like to HELP! to be available on.
  22.  
  23. HELP! should be copied into the C directory of your disk so that it can
  24. be used in exactly the same way as the other CLI commands.
  25.  
  26. The help file, HelpA.HELP should be copied to the root directory of your
  27. disk.
  28.  
  29. You could also, as part of your startup-sequence, copy HelpA.HELP to RAM:.
  30. This would greatly decrease the time taken to get help on a subject.
  31.  
  32.                               USING HELP!
  33.  
  34. Help is called by typing:
  35.  
  36.                      HELP! <keyword>
  37.  
  38. Where <keyword> is the subject that you require information on. The keyword
  39. can consist of two or more characters, although only the first six are used.
  40.  
  41. If HELP! matches the keyword with a subject in a help file, information
  42. about that subject will be displayed. You can pause the display by
  43. pressing any key then backspace or return to continue.
  44.  
  45. If a match is not made, HELP! will display the message
  46.  
  47.                    Sorry no help available on <subject>
  48.  
  49. Where <subject> is the keyword you supplied.
  50.  
  51. If you call HELP! and there is no help file available the message
  52.  
  53.                    There is no help currently available
  54.  
  55. is displayed. This means that you have not copied the file HelpA.HELP to
  56. either your root directory on disk or to RAMdisk.
  57.  
  58.                             WHAT HELP! DOES
  59.  
  60. When you call HELP! it looks for a file called HelpA.HELP in the current
  61. directory, then it looks for it in the RAMdisk RAM: and then finally in
  62. the root directory of the disk df0:. If it doesn't find this file the
  63. message 'There is no help currently available' is displayed and you are
  64. returned to the CLI command line.
  65.  
  66. If HelpA.HELP is found HELP! searches through it to try and find a match
  67. with the keyword that you supplied. If it finds a match, it displays
  68. information related to the keyword. If a match is not found, HELP! then
  69. looks for another file to search called HelpB.HELP. If a match is not found
  70. in this file it then looks for file called HelpC.HELP and so on up to
  71. HelpZ.HELP. If a match is not made in any existing help file the message
  72. 'Sorry no help available on <keyword>', where <keyword> is the keyword that
  73. you supplied.
  74.  
  75.                       CREATING YOUR OWN HELP FILES
  76.  
  77. Although a help file on AmigaDos commands is provided you can create help
  78. files of your own for HELP! to use. The help files that you create should
  79. follow these guildelines:
  80.  
  81.   Each help file consists of keywords followed by information about
  82.   that keyword. 
  83.  
  84.   Each keyword is identified by placing a \ in front of it and should
  85.   consist of no more than six characters.
  86.  
  87.   Any text after the sixth character on the line containing the keyword
  88.   will be displayed by HELP! until a ~ is found. The ~ marks the end of
  89.   information relating to the keyword.
  90.  
  91. Here is an example of a simple help file
  92.  
  93.    \AMIGA  Amiga is a wonderful micro~
  94.    \AUTHOR The author is a wonderful human being~
  95.  
  96. So if you asked for help on 'AMIGA', HELP! would look for a '\' then check
  97. the six following characters to see if they were same as or part of 'AMIGA'.
  98. Then the string ' Amiga is a wonderful micro' would be displayed. Before
  99. comparing any characters HELP! changes them to upper case, so that both
  100. the keyword and the six characters following the '\' can be upper or lower
  101. case or a mixture of both.
  102.  
  103. Any help files you create should be 32 Kbytes or smaller and they should be
  104. named HelpA.HELP through to HelpZ.HELP, IN ORDER. So if you had three help
  105. files the first file to be searched should be called HelpA.HELP, the second
  106. called HelpB.HELP and the third called HelpC.Help.
  107.  
  108. Look at the file 'HelpA.HELP' on this disk to see an example of a help
  109. file.
  110.  
  111. -Gary Ismay October 88
  112.